/*
   Copyright (c) 2011 Mizar Tools Contributors (mizartools.org)

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
/*  Contributors :
 *	2011-02-05 Marco Riccardi - initial implementation
 *  2011-03-25 Marco Riccardi - implementation of visitor pattern
 *
 */
package org.mizartools.system.xml;

import java.util.LinkedList;

import org.mizartools.system.ClusterRegistrationKind;
import org.mizartools.system.ElementParseException;
import org.mizartools.system.IClusterRegistration;
import org.mizartools.system.IElement;
import org.mizartools.system.INode;
import org.mizartools.utility.xml.XMLAttribute;
import org.mizartools.utility.xml.XMLElement;

public class FCluster implements IElement, IClusterRegistration {


    public static final String NAME = "FCluster";

    private INode parentNode;
    private String aid = null;
    private Integer nr = null;

    private ErrorCluster errorCluster = null;
    private ArgTypes argTypes = null;
    private Term term = null;
    private Cluster cluster1 = null;
    private Cluster cluster2 = null;
    private Typ typ = null;


    private FCluster(INode parentNode){
        this.parentNode = parentNode;
    }

    public INode getParentNode() {
        return parentNode;
    }

    public static FCluster newInstance(INode parentNode, LinkedList<XMLElement> xmlElementList) throws ElementParseException {
        FCluster fCluster = new FCluster(parentNode);
        XMLElement xmlElement = xmlElementList.poll();
        if (!xmlElement.getName().equals(NAME)){
            throw new ElementParseException(ElementParseException.NOT_VALID_ELEMENT, "XMLElement is a " + xmlElement.getName() + " not a " + NAME, xmlElementList);
        }
        for (XMLAttribute xmlAttribute : xmlElement.getXMLAttributeList()){
            if (xmlAttribute.getName().equals("aid")){
                if (fCluster.aid == null){
                    fCluster.aid = xmlAttribute.getValue();
                } else {
                    throw new ElementParseException(ElementParseException.DUPLICATE_ATTRIBUTE_ELEMENT, "XMLElement has a duplicate attribute " + xmlAttribute.getName(), xmlElementList);
                } 
            } else 
            if (xmlAttribute.getName().equals("nr")){
                if (fCluster.nr == null){
                    try {fCluster.nr = Integer.parseInt(xmlAttribute.getValue());}
                    catch (Exception e) {throw new ElementParseException(ElementParseException.NOT_VALID_TYPE_OF_ATTRIBUTE_ELEMENT, "XMLElement has an attribute " + xmlAttribute.getName() + " with an invalid type", xmlElementList);};
                } else {
                    throw new ElementParseException(ElementParseException.DUPLICATE_ATTRIBUTE_ELEMENT, "XMLElement has a duplicate attribute " + xmlAttribute.getName(), xmlElementList);
                } 
            } else 
                throw new ElementParseException(ElementParseException.NOT_VALID_ATTRIBUTE_ELEMENT, "XMLElement has not a valid attribute " + xmlAttribute.getName(), xmlElementList);
        }

        if (!xmlElement.isEmpty()){
            while (true){
                xmlElement = xmlElementList.peek();
                if (xmlElement == null){
                    throw new ElementParseException(ElementParseException.UNEXPECTED_END_OF_FILE, "Unexpected end of XMLElement list");
                }
                if (xmlElement.getName().equals(NAME) && xmlElement.isEndElement()){
                    xmlElement = xmlElementList.poll();
                    break;
                }
                if (xmlElement.getName().equals("ErrorCluster")){
                    if (fCluster.errorCluster == null) {
                        fCluster.errorCluster = ErrorCluster.newInstance(fCluster, xmlElementList);
                    } else { 
                        throw new ElementParseException(ElementParseException.DUPLICATE_ELEMENT, "XMLElement list contains a duplicated <ErrorCluster> in element " + NAME, xmlElementList);
                    }
                } else if (xmlElement.getName().equals("ArgTypes")){
                    if (fCluster.argTypes == null) {
                        fCluster.argTypes = ArgTypes.newInstance(fCluster, xmlElementList);
                    } else { 
                        throw new ElementParseException(ElementParseException.DUPLICATE_ELEMENT, "XMLElement list contains a duplicated <ArgTypes> in element " + NAME, xmlElementList);
                    }
                } else if (Term.isTerm(xmlElement.getName())){
                    if (fCluster.term == null) {
                        fCluster.term = Term.newInstance(fCluster, xmlElementList);
                    } else { 
                        throw new ElementParseException(ElementParseException.DUPLICATE_ELEMENT, "XMLElement list contains a duplicated <Term> in element " + NAME, xmlElementList);
                    }
                } else if (xmlElement.getName().equals("Cluster") && fCluster.cluster1 == null) {
                    fCluster.cluster1 = Cluster.newInstance(fCluster, xmlElementList);
                } else if (xmlElement.getName().equals("Cluster")){
                    if (fCluster.cluster2 == null) {
                        fCluster.cluster2 = Cluster.newInstance(fCluster, xmlElementList);
                    } else { 
                        throw new ElementParseException(ElementParseException.DUPLICATE_ELEMENT, "XMLElement list contains a duplicated <Cluster> in element " + NAME, xmlElementList);
                    }
                } else if (xmlElement.getName().equals("Typ")){
                    if (fCluster.typ == null) {
                        fCluster.typ = Typ.newInstance(fCluster, xmlElementList);
                    } else { 
                        throw new ElementParseException(ElementParseException.DUPLICATE_ELEMENT, "XMLElement list contains a duplicated <Typ> in element " + NAME, xmlElementList);
                    }
                } else 
                    throw new ElementParseException(ElementParseException.NOT_VALID_ELEMENT, "The XMLElement " + xmlElement.getName() + " is not valid in " + NAME, xmlElementList);
            }
        }

        return fCluster;
    }

    public LinkedList<XMLElement> getXMLElementList() {
        LinkedList<XMLElement> xmlElementList = new LinkedList<XMLElement>();
        XMLElement xmlElement = new XMLElement(NAME);
        if (this.aid != null) {
            XMLAttribute xmlAttribute = new XMLAttribute("aid", this.aid);
            xmlElement.getXMLAttributeList().add(xmlAttribute);
        }
        if (this.nr != null) {
            XMLAttribute xmlAttribute = new XMLAttribute("nr", this.nr);
            xmlElement.getXMLAttributeList().add(xmlAttribute);
        }
        boolean isEmpty = !(errorCluster != null
         || argTypes != null || term != null
         || cluster1 != null || cluster2 != null
         || typ != null);
        xmlElement.setEmpty(isEmpty);
        xmlElementList.add(xmlElement);
        if (this.errorCluster != null){
            xmlElementList.addAll(this.errorCluster.getXMLElementList());
        }
        if (this.argTypes != null){
            xmlElementList.addAll(this.argTypes.getXMLElementList());
        }
        if (this.term != null){
            xmlElementList.addAll(this.term.getXMLElementList());
        }
        if (this.cluster1 != null){
            xmlElementList.addAll(this.cluster1.getXMLElementList());
        }
        if (this.cluster2 != null){
            xmlElementList.addAll(this.cluster2.getXMLElementList());
        }
        if (this.typ != null){
            xmlElementList.addAll(this.typ.getXMLElementList());
        }
        if (!isEmpty) { 
            xmlElement = new XMLElement(NAME);
            xmlElement.setEndElement(true);
            xmlElementList.add(xmlElement);
        }
        return xmlElementList;
    }

    public String getAid(){
        return aid;
    }

    public Integer getNr(){
        return nr;
    }

    public ErrorCluster getErrorCluster(){
        return errorCluster;
    }

    public ArgTypes getArgTypes(){
        return argTypes;
    }

    public Term getTerm(){
        return term;
    }

    public Cluster getCluster1(){
        return cluster1;
    }

    public Cluster getCluster2(){
        return cluster2;
    }

    public Typ getTyp(){
        return typ;
    }

    public ClusterRegistrationKind getClusterRegistrationKind(){
    	return ClusterRegistrationKind.funcreg;
    }

    public Integer getClusterRegistrationNr(){
    	return nr;
    }

	@Override
	public void accept(Visitor visitor) {
		if (visitor.visit(this)) {}
		visitor.endVisit(this);
	}

	@Override
	public String toString(){
		ToStringVisitor toStringVisitor = new ToStringVisitor();
		this.accept(toStringVisitor);
		return toStringVisitor.toString();
	}

}
